home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / jdic23.zip / JREADR23.DOC < prev    next >
Text File  |  1993-07-01  |  17KB  |  353 lines
  1.  
  2.                                  J R E A D E R
  3.  
  4.       Japanese Text Reader with Online Dictionary Search & Yomikata Lookup
  5.       ====================================================================
  6.  
  7.                                   Version 2.3 
  8.  
  9.  
  10.                                    J.W. Breen
  11.                                     May 1993
  12.                                     
  13.  
  14.                                  CONTENTS
  15.  
  16.                         1. INTRODUCTION
  17.  
  18.                         2. THIS DOCUMENT
  19.  
  20.                         3. INSTALLATION
  21.  
  22.                         4. ENVIRONMENT
  23.  
  24.                         5. OPERATION
  25.  
  26.                         6. DICTIONARY SEARCHING 
  27.  
  28.                         7. VERB & ADJECTIVE MODIFICATION
  29.  
  30.                         8. YOMIKATA SEARCHING
  31.  
  32.                         9. KANJI INFORMATION
  33.  
  34.                        10. ADDITIONS TO PREVIOUS VERSION(S)
  35.  
  36.                        11. AUTHOR'S COMMENT
  37.  
  38.  
  39. 1. INTRODUCTION 
  40. --------------- 
  41.  
  42. This program provides a capability to display a text file  containing  Japanese 
  43. characters  (kana  &  kanji) with the option of looking up displayed words in a 
  44. Japanese/English dictionary file or in MOKE's kanji-to-kana yomikata file.  
  45.  
  46. The  Japanese  characters in the text files can either be in the EUC,  New-JIS, 
  47. Old-JIS or Shift-JIS codes.  In the case of EUC and  Shift-JIS,  hankaku  codes 
  48. are not supported. A file containing other codes, such as NEC-JIS, etc., can be 
  49. concerted  into  one  of  the  supported codes using utilities such as "jc" and 
  50. "jconv". 
  51.                  
  52. Although JREADER is intended to help non-Japanese people read Japanese language 
  53. text files,  it can also  be  used  by  Japanese  to  read  English  text.  Its 
  54. usefulness in this role is limited by the dictionary, which is more oriented to 
  55. the  Japanese  to English mode,  and the fact that the dictionary search cannot 
  56. cope with things like  English's  "strong"  verbs  (swim/swam/swum,  be/am/are, 
  57. go/went, etc.). 
  58.  
  59. JREADER  is  an  extension  of  the  author's JDIC (Japanese/English Dictionary 
  60. Display) program,  which  has  been  designed  specifically  to  operate  on  a 
  61. dictionary in the "EDICT" format originally used by the MOKE (Mark's Own  Kanji 
  62. Editor)  Japanese  text editor.  As with JDIC,  JREADER's operating environment 
  63. has been designed to be similar to MOKE's,  and it can use the same environment 
  64. variables  and  control  file as MOKE.  Along with JDIC,  it will be updated to 
  65. track MOKE versions (at present it is aligned with the MOKE V2.1.) 
  66.  
  67. The  executable  code  and  documentation  of JREADER is hereby released to the 
  68. "public domain".  All usage of this program is at the user's risk, and there is 
  69. no warranty on its performance. 
  70.  
  71. All the Japanese displayed is in kana and kanji, so if you cannot read at least 
  72. hiragana  and katakana,  this program will not be much use for you.  The author 
  73. has NO intention of producing a version using romanized Japanese. 
  74.  
  75. 2. THIS DOCUMENT
  76. ----------------
  77.  
  78. JREADER is an extension of JDIC, and shares a similar operating method as JDIC. 
  79. Consequently this document file only includes details of where JREADER  differs 
  80. from JDIC. Please make sure you have and read the appropriate JDICnn.doc file. 
  81.  
  82. 3. INSTALLATION
  83. ---------------
  84.  
  85. This program is distributed in a "zoo"  archive  (jdic23.zoo).  Both  JDIC  and 
  86. JREADER  share  a common operating environment.  Please follow the installation 
  87. details in JDIC23.DOC, which is in the "JDIC23.ZOO" file. 
  88.  
  89. In addition,  to get the full function from JREADER,  you should have the files 
  90. WSKTOK.DAT  and WSKTOK.IND.  These are the kanji_to_kana file from MOKE and its 
  91. index file.  Without them the "y" (yomikata lookup) function will not  operate. 
  92. If you are a MOKE user (Version 2.0 or later) you will have them. 
  93.  
  94. The author has produced an expanded form of the WSKTOK.DAT file  by  adding  in 
  95. the  additional  entries  in  EDICT,  plus  further  entries  from the full WNN 
  96. dictionary.  This is available in the WSKWNN.ZOO file,  along with  a  matching 
  97. WSKTOK.IND index file. 
  98.  
  99. (For the curious,  there is an explanation of these files  in  an  Appendix  to 
  100. JDIC23.DOC.) 
  101.  
  102. 4. ENVIRONMENT
  103. --------------
  104.  
  105. JREADER uses the same environment variables and JDIC.RC/MOKE.RC fields as  JDIC 
  106. (and  MOKE).  These  affect  things like paths and colours.  See JDIC23.DOC for 
  107. details. 
  108.  
  109. In addition,  JREADER has one special (optional) entry in  the  JDIC.RC/MOKE.RC 
  110. file.  The  verb/adjective deinflection function (see below) can be disabled by 
  111. the following line in JDIC.RC/MOKE.RC: 
  112.  
  113. jverb   off
  114.  
  115. The default is for this option to be enabled.
  116.  
  117. 5. OPERATION
  118. ------------
  119.  
  120. (a) LOADING
  121.  
  122. JREADER is simple to operate. The command-line invocation is: 
  123.  
  124.          jreader <options> text-file(s)
  125.  
  126. The same -l,  -f,  -cDIR and -bnn options are used as  in  JDIC.  In  addition, 
  127. JREADER uses: 
  128.  
  129.  -sn (3 < n < 8) specifies that the text window is to use n/10 of  the  screen, 
  130.                    The default is n = 7. 
  131.  
  132.  -ddictionary-file  specifies  the  file  that is to be used as the dictionary, 
  133.                    along with an index file with an extension of  ".jdx".  This 
  134.                    latter  file  must be created using the JDXGEN utility.  The 
  135.                    default is "edict" with "edict.jdx" as the  index  file,  or 
  136.                    "jtoe.dct" and "jtoe.jdx", whichever is present. 
  137.                                        
  138.  -Llogfile specifies the name of a file to log possible  new  "edict"  entries. 
  139.                    The default name is "jreader.log". 
  140.                    
  141. One or more file names can be provided. MS-DOS wildcards can be used also.
  142.            
  143. (b) READING FILES
  144.  
  145. The working screen of JREADER contains two windows. The upper displays the text 
  146. being read,  the lower displays control information,  and  the  dictionary  and 
  147. yomikata search results. 
  148.  
  149. The first screenful of the text file is displayed when the program starts. From 
  150. then on most operation is by single keystroke commands. They are: 
  151.  
  152. <PgDn> reads the next screen of the file.  The last line of the previous screen 
  153. is repeated as the first line of the next.
  154.  
  155. <PgUp> reads the  previous  screen  of  the  file.  The  backspacing  technique 
  156. involves  backspacing  the number of lines on the current screen,  so it should 
  157. usually result in the previous screen  being  displayed,  unless  there  are  a 
  158. number of "folded" lines. 
  159.  
  160. <Ctrl-PgUp> restarts the file from the beginning.
  161.           
  162. <Ctrl-PgDn> skips to the end of the file, and displays the last 10 lines.
  163.  
  164. <Arrow>  The  four  arrow  keys  can  be  used  to  position the cursor under a 
  165. character which may be used as the start of a key for a  dictionary  search.  A 
  166. down-arrow  while  on the last line causes the display to scroll down one line, 
  167. and an up-arrow on the first line causes an upwards scroll. 
  168.  
  169. <Enter> positions the cursor at the start of the next line. 
  170.  
  171. <End> positions the cursor at the end of the current line. 
  172.  
  173. <Home> positions the cursor at the start of the current line. 
  174.  
  175. <Ctrl-Home> positions the cursor at the start of the screen.
  176.  
  177. <Ctrl-End> positions the cursor at the last line of the screen.
  178.  
  179. <Space>  triggers  a dictionary search using the string of characters beginning 
  180. with the one marked by the cursor. (See below.) 
  181.                                  
  182. <a> the same dictionary search as <space>,  but if the search key  begins  with 
  183. one  or more kanji characters,  the search will match against any occurrence of 
  184. the character(s) among kanji compounds in the dictionary, instead of just those 
  185. at the start of compounds. 
  186.  
  187. </> invokes a prompt for a string of  characters,  the  the  file  is  searched 
  188. forwards  until  a  line  is  found  containing  that string.  Ths scan is case 
  189. sensitive. 
  190.  
  191. <l>  logs  the  character  string  marked  by  the cursor to a file (default is 
  192. "jreader.log").  The logged data is  in  "edict"  format,  i.e.  `kanji  [kana] 
  193. /english .../', with the logged characte